home *** CD-ROM | disk | FTP | other *** search
- /* Copyright (C) 1995, 1997 Aladdin Enterprises. All rights reserved.
-
- This file is part of Aladdin Ghostscript.
-
- Aladdin Ghostscript is distributed with NO WARRANTY OF ANY KIND. No author
- or distributor accepts any responsibility for the consequences of using it,
- or for whether it serves any particular purpose or works at all, unless he
- or she says so in writing. Refer to the Aladdin Ghostscript Free Public
- License (the "License") for full details.
-
- Every copy of Aladdin Ghostscript must include a copy of the License,
- normally in a plain ASCII text file named PUBLIC. The License grants you
- the right to copy, modify and redistribute Aladdin Ghostscript, but only
- under certain conditions described in the License. Among other things, the
- License requires that the copyright notice and this notice be preserved on
- all copies.
- */
-
- /* gxclio.h */
- /* I/O interface for command lists */
-
- #ifndef gxclio_INCLUDED
- # define gxclio_INCLUDED
-
- /*
- * There are two implementations of the I/O interface for command lists --
- * one suitable for embedded systems, which stores the "files" in RAM, and
- * one suitable for other systems, which uses an external file system --
- * with the choice made at compile/link time. This header file defines the
- * API between the command list code proper and its I/O interface.
- */
-
- typedef void *clist_file_ptr; /* We can't do any better than this. */
-
- /* ---------------- Open/close/unlink ---------------- */
-
- /*
- * If *fname = 0, generate and store a new scratch file name; otherwise,
- * open an existing file. Only modes "r" and "w+" are supported,
- * and only binary data (but the caller must append the "b" if needed).
- * Mode "r" with *fname = 0 is an error.
- */
- int clist_fopen(P5(char *fname, const char *fmode, clist_file_ptr *pcf,
- gs_memory_t *mem, bool ok_to_compress));
-
- /*
- * Close a file, optionally deleting it.
- */
- int clist_fclose(P3(clist_file_ptr cf, const char *fname, bool delete));
-
- /*
- * Delete a file.
- */
- int clist_unlink(P1(const char *fname));
-
- /* ---------------- Writing ---------------- */
-
- /* clist_space_available returns min(requested, available). */
- long clist_space_available(P1(long requested));
-
- int clist_fwrite_chars(P3(const void *data, uint len, clist_file_ptr cf));
-
- /* ---------------- Reading ---------------- */
-
- int clist_fread_chars(P3(void *data, uint len, clist_file_ptr cf));
-
- /* ---------------- Position/status ---------------- */
-
- /* clist_ferror_code returns an error code per gserrors.h, not a Boolean. */
- int clist_ferror_code(P1(clist_file_ptr cf));
-
- long clist_ftell(P1(clist_file_ptr cf));
-
- /*
- * We pass the file name to clist_rewind and clist_fseek in case the
- * implementation has to close and reopen the file. (clist_fseek with
- * offset = 0 and mode = SEEK_END indicates we are about to append.)
- */
- void clist_rewind(P3(clist_file_ptr cf, bool discard_data,
- const char *fname));
-
- int clist_fseek(P4(clist_file_ptr cf, long offset, int mode,
- const char *fname));
-
- #endif /* gxclio_INCLUDED */
-